home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / tput.z / tput
Text File  |  1998-10-20  |  16KB  |  267 lines
  1.  
  2.  
  3.  
  4. ttttppppuuuutttt((((1111))))                                                                ttttppppuuuutttt((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _tttt_pppp_uuuu_tttt - initialize a terminal or query terminfo database
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _tttt_pppp_uuuu_tttt [_----_TTTT_t_y_p_e] _c_a_p_n_a_m_e [_p_a_r_m_s ... ]
  13.      _tttt_pppp_uuuu_tttt [_----_TTTT_t_y_p_e] _iiii_nnnn_iiii_tttt
  14.      _tttt_pppp_uuuu_tttt [_----_TTTT_t_y_p_e] _rrrr_eeee_ssss_eeee_tttt
  15.      _tttt_pppp_uuuu_tttt [_----_TTTT_t_y_p_e] _llll_oooo_nnnn_gggg_nnnn_aaaa_mmmm_eeee
  16.      _tttt_pppp_uuuu_tttt _----_SSSS  _<<<<_<<<<
  17.  
  18. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.      _tttt_pppp_uuuu_tttt uses the _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database to make the values of terminal-dependent
  20.      capabilities and information available to the shell (see _ssss_hhhh(1)), to
  21.      initialize or reset the terminal, or return the long name of the
  22.      requested terminal type.  _tttt_pppp_uuuu_tttt outputs a string if the attribute
  23.      (_c_a_pability _n_a_m_e) is of type string, or an integer if the attribute is of
  24.      type integer.  If the attribute is of type boolean, _tttt_pppp_uuuu_tttt simply sets the
  25.      exit code (_0000 for TRUE if the terminal has the capability, _1111 for FALSE if
  26.      it does not), and produces no output.  Before using a value returned on
  27.      standard output, the user should test the exit code [_$$$$_????, see _ssss_hhhh(1)] to be
  28.      sure it is _0000.  (See the EXIT CODES and DIAGNOSTICS sections.)  For a
  29.      complete list of capabilities and the _c_a_p_n_a_m_e associated with each, see
  30.      _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo(4).
  31.  
  32.      _----_TTTT_t_y_p_e     indicates the _t_y_p_e of terminal.  Normally this option is
  33.                 unnecessary, because the default is taken from the environment
  34.                 variable _TTTT_EEEE_RRRR_MMMM.  If _----_TTTT is specified, then the shell variables
  35.                 _LLLL_IIII_NNNN_EEEE_SSSS and _CCCC_OOOO_LLLL_UUUU_MMMM_NNNN_SSSS and the layer size [see _llll_aaaa_yyyy_eeee_rrrr_ssss(1)] will not
  36.                 be referenced.
  37.  
  38.      _c_a_p_n_a_m_e    indicates the attribute from the _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database.
  39.  
  40.      _p_a_r_m_s      If the attribute is a string that takes parameters, the
  41.                 arguments _p_a_r_m_s will be instantiated into the string.  An all
  42.                 numeric argument will be passed to the attribute as a number.
  43.  
  44.      _----_SSSS         allows more than one capability per invocation of _tttt_pppp_uuuu_tttt.  The
  45.                 capabilities must be passed to _tttt_pppp_uuuu_tttt from the standard input
  46.                 instead of from the command line (see example).  Only one
  47.                 _c_a_p_n_a_m_e is allowed per line.  The _----_SSSS option changes the
  48.                 meaning of the _0000 and _1111 boolean and string exit codes (see the
  49.                 EXIT CODES section).
  50.  
  51.      _iiii_nnnn_iiii_tttt       If the _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database is present and an entry for the
  52.                 user's terminal exists (see _----_TTTT_t_y_p_e, above), the following will
  53.                 occur:  (1) if present, the terminal's initialization strings
  54.                 will be output (_iiii_ssss_1111, _iiii_ssss_2222, _iiii_ssss_3333, _iiii_ffff, _iiii_pppp_rrrr_oooo_gggg), (2) any delays
  55.                 (e.g., newline) specified in the entry will be set in the tty
  56.                 driver, (3) tabs expansion will be turned on or off according
  57.                 to the specification in the entry, and (4) if tabs are not
  58.  
  59.  
  60.  
  61.                                                                         PPPPaaaaggggeeee 1111
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. ttttppppuuuutttt((((1111))))                                                                ttttppppuuuutttt((((1111))))
  69.  
  70.  
  71.  
  72.                 expanded, standard tabs will be set (every 8 spaces).  If an
  73.                 entry does not contain the information needed for any of the
  74.                 four above activities, that activity will silently be skipped.
  75.  
  76.      _rrrr_eeee_ssss_eeee_tttt      Instead of putting out initialization strings, the terminal's
  77.                 reset strings will be output if present (_rrrr_ssss_1111, _rrrr_ssss_2222, _rrrr_ssss_3333, _rrrr_ffff).
  78.                 If the reset strings are not present, but initialization
  79.                 strings are, the initialization strings will be output.
  80.                 Otherwise, _rrrr_eeee_ssss_eeee_tttt acts identically to _iiii_nnnn_iiii_tttt.
  81.  
  82.      _llll_oooo_nnnn_gggg_nnnn_aaaa_mmmm_eeee   If the _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database is present and an entry for the
  83.                 user's terminal exists (see _----_TTTT_t_y_p_e above), then the long name
  84.                 of the terminal will be put out.  The long name is the last
  85.                 name in the first line of the terminal's description in the
  86.                 _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database [see _tttt_eeee_rrrr_mmmm(5)].
  87.  
  88.    IIIInnnntttteeeerrrrnnnnaaaattttiiiioooonnnnaaaallll FFFFuuuunnnnccccttttiiiioooonnnnssss
  89.      _c_a_p_n_a_m_e_s for international functionality can also be specified.
  90.  
  91. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  92.      _tttt_pppp_uuuu_tttt _iiii_nnnn_iiii_tttt         Initialize the terminal according to the type of
  93.                        terminal in the environmental variable _TTTT_EEEE_RRRR_MMMM.  This
  94.                        command should be included in everyone's .profile after
  95.                        the environmental variable _TTTT_EEEE_RRRR_MMMM has been exported, as
  96.                        illustrated on the _pppp_rrrr_oooo_ffff_iiii_llll_eeee(4) manual page.
  97.  
  98.      _tttt_pppp_uuuu_tttt _----_TTTT_5555_6666_2222_0000 _rrrr_eeee_ssss_eeee_tttt Reset an AT&T 5620 terminal, overriding the type of
  99.                        terminal in the environmental variable _TTTT_EEEE_RRRR_MMMM.
  100.  
  101.      _tttt_pppp_uuuu_tttt _cccc_uuuu_pppp _0000 _0000      Send the sequence to move the cursor to row _0000, column _0000
  102.                        (the upper left corner of the screen, usually known as
  103.                        the "home" cursor position).
  104.  
  105.      _tttt_pppp_uuuu_tttt _cccc_llll_eeee_aaaa_rrrr        Echo the clear-screen sequence for the current
  106.                        terminal.
  107.  
  108.      _tttt_pppp_uuuu_tttt _cccc_oooo_llll_ssss         Print the number of columns for the current terminal.
  109.  
  110.      _tttt_pppp_uuuu_tttt _----_TTTT_4444_5555_0000 _cccc_oooo_llll_ssss   Print the number of columns for the 450 terminal.
  111.  
  112.      _bbbb_oooo_llll_dddd_====_````_tttt_pppp_uuuu_tttt _ssss_mmmm_ssss_oooo_````
  113.  
  114.      _oooo_ffff_ffff_bbbb_oooo_llll_dddd_====_````_tttt_pppp_uuuu_tttt _rrrr_mmmm_ssss_oooo_````
  115.                        Set the shell variables _bbbb_oooo_llll_dddd, to begin stand-out mode
  116.                        sequence, and _oooo_ffff_ffff_bbbb_oooo_llll_dddd, to end standout mode sequence,
  117.                        for the current terminal.  This might be followed by a
  118.                        prompt:
  119.                        _eeee_cccc_hhhh_oooo _""""_$$$$_{{{{_bbbb_oooo_llll_dddd_}}}}_PPPP_llll_eeee_aaaa_ssss_eeee _tttt_yyyy_pppp_eeee _iiii_nnnn _yyyy_oooo_uuuu_rrrr _nnnn_aaaa_mmmm_eeee_:::: _$$$$_{{{{_oooo_ffff_ffff_bbbb_oooo_llll_dddd_}}}}_\\\\_cccc_""""
  120.  
  121.      _tttt_pppp_uuuu_tttt _hhhh_cccc           Set exit code to indicate if the current terminal is a
  122.                        hardcopy terminal.
  123.  
  124.  
  125.  
  126.  
  127.                                                                         PPPPaaaaggggeeee 2222
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134. ttttppppuuuutttt((((1111))))                                                                ttttppppuuuutttt((((1111))))
  135.  
  136.  
  137.  
  138.      _tttt_pppp_uuuu_tttt _cccc_uuuu_pppp _2222_3333 _4444     Send the sequence to move the cursor to row 23, column
  139.                        4.
  140.  
  141.      _tttt_pppp_uuuu_tttt _llll_oooo_nnnn_gggg_nnnn_aaaa_mmmm_eeee     Print the long name from the _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database for the
  142.                        type of terminal specified in the environmental
  143.                        variable _TTTT_EEEE_RRRR_MMMM.
  144.      _tttt_pppp_uuuu_tttt _----_SSSS _<<<<_<<<<_!!!!
  145.      _>>>> _cccc_llll_eeee_aaaa_rrrr
  146.      _>>>> _cccc_uuuu_pppp _1111_0000 _1111_0000
  147.      _>>>> _bbbb_oooo_llll_dddd
  148.      _>>>> _!!!!
  149.                        This example shows tput processing several capabilities
  150.                        in one invocation.  This example clears the screen,
  151.                        moves the cursor to position 10, 10 and turns on bold
  152.                        (extra bright) mode.  The list is terminated by an
  153.                        exclamation mark (_!!!!)  on a line by itself.
  154.  
  155. FFFFIIIILLLLEEEESSSS
  156.      _////_uuuu_ssss_rrrr_////_ssss_hhhh_aaaa_rrrr_eeee_////_llll_iiii_bbbb_////_tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo_////_????_////_****
  157.                          compiled terminal description database
  158.      _////_uuuu_ssss_rrrr_////_iiii_nnnn_cccc_llll_uuuu_dddd_eeee_////_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh
  159.                          _cccc_uuuu_rrrr_ssss_eeee_ssss(3X) header file
  160.      _////_uuuu_ssss_rrrr_////_iiii_nnnn_cccc_llll_uuuu_dddd_eeee_////_tttt_eeee_rrrr_mmmm_...._hhhh _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo header file
  161.      _////_uuuu_ssss_rrrr_////_llll_iiii_bbbb_////_tttt_aaaa_bbbb_ssss_eeee_tttt_////_****   tab settings for some terminals, in a format
  162.                          appropriate to be output to the terminal (escape
  163.                          sequences that set margins and tabs); for more
  164.                          information, see the "Tabs and Initialization"
  165.                          section of _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo(4)
  166.  
  167. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  168.      _cccc_llll_eeee_aaaa_rrrr(1), _ssss_tttt_tttt_yyyy(1), _tttt_aaaa_bbbb_ssss(1)
  169.      _pppp_rrrr_oooo_ffff_iiii_llll_eeee(4), _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo(4)
  170.  
  171. EEEEXXXXIIIITTTT CCCCOOOODDDDEEEESSSS
  172.      If _c_a_p_n_a_m_e is of type boolean, a value of _0000 is set for TRUE and _1111 for
  173.      FALSE unless the _----_SSSS option is used.
  174.  
  175.      If _c_a_p_n_a_m_e is of type string, a value of _0000 is set if the _c_a_p_n_a_m_e is
  176.      defined for this terminal _t_y_p_e (the value of _c_a_p_n_a_m_e is returned on
  177.      standard output); a value of _1111 is set if _c_a_p_n_a_m_e is not defined for this
  178.      terminal _t_y_p_e (a null value is returned on standard output).
  179.  
  180.      If _c_a_p_n_a_m_e is of type boolean or string and the _----_SSSS option is used, a
  181.      value of _0000 is returned to indicate that all lines were successful.  No
  182.      indication of which line failed can be given so exit code _1111 will never
  183.      appear.  Exit codes _2222, _3333, and _4444 retain their usual interpretation.
  184.  
  185.      If _c_a_p_n_a_m_e is of type integer, a value of _0000 is always set, whether or not
  186.      _c_a_p_n_a_m_e is defined for this terminal _t_y_p_e.  To determine if _c_a_p_n_a_m_e is
  187.      defined for this terminal _t_y_p_e, the user must test the value of standard
  188.      output.  A value of _----_1111 means that _c_a_p_n_a_m_e is not defined for this
  189.      terminal _t_y_p_e.
  190.  
  191.      Any other exit code indicates an error; see the DIAGNOSTICS section.
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.                                                                         PPPPaaaaggggeeee 3333
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205. ttttppppuuuutttt((((1111))))                                                                ttttppppuuuutttt((((1111))))
  206.  
  207.  
  208.  
  209. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  210.      _tttt_pppp_uuuu_tttt prints the following error messages and sets the corresponding exit
  211.      codes.
  212.         exit
  213.         code             error message
  214.          _0000   -1  (_c_a_p_n_a_m_e is a numeric variable that is not specified in the
  215.              _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo(4) database for this terminal type, e.g.
  216.              _tttt_pppp_uuuu_tttt _----_TTTT_4444_5555_0000 _llll_iiii_nnnn_eeee_ssss and _tttt_pppp_uuuu_tttt _----_TTTT_2222_6666_2222_1111 _xxxx_mmmm_cccc)
  217.          _1111   no error message is printed, see the EEEEXXXXIIIITTTT CCCCOOOODDDDEEEESSSS section.
  218.          _2222   usage error
  219.          _3333   unknown terminal _t_y_p_e or no _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database
  220.          _4444   unknown _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo capability _c_a_p_n_a_m_e
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  261.  
  262.  
  263.                                                                         PPPPaaaaggggeeee 4444
  264.  
  265.  
  266.  
  267.